eFAWATEERcom Bank Prc
Postpaid Payment Account
URLs :
Description : This service allows the channel or Bank itself to initiate a Postpaid payment before payment to eFAWATEERcom through Bank Account.
The Bill Payment service for postpaid through account permits Bank and channels to create new postpaid payment record in eFAWATEERcom. The service is intended to involve a set of validations on the received payment, if the validation process is successful,eFAWATEERcom will generate a payment transaction number ‘JOEBPPSTrx’ and return it in the response message to the Bank/PSP. Bank/PSP should get the latest bill details first by sending bill inquiry request.
Mulesoft Request:
Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret
Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id
Request Body: application/json
| Field Name | Type | Length | Occurrence | Description |
|---|---|---|---|---|
| postpaidAccountTransactions | Object | M | ||
| trxInf | Array | M | Repeatable | |
| acctInfo | Object | M | ||
| billingNo | String | 50 | M | Represents the unique identifier of subscription in a specific service provided by the biller. Field returned from bill inquiry |
| billNo | String | 50 | M | bill no, Field returned from bill inquiry |
| billerCode | Integer | 3 | M | Represents the unique code of the Biller Field returned from bill inquiry |
| End of acctInfo | ||||
| inqRefNo | Integer | 20 | M | Represents the Inquiry Reference Number which connect the bill inquiry with the corresponding bill payment transaction. Field returned from bill inquiry |
| bankTrxID | String | 50 | M | Unique transaction number which is generated for banks collecting payments |
| pmtStatus | String | 15 | M | Represents the status of the collected payment Hardcode to "PmtNew" |
| dueAmt | Decimal | 12,3 | M | the due amount of the uploaded bill |
| paidAmt | Decimal | 12,3 | M | Represents the collected payment amount |
| processDate | DateTime | M | Represents the payment transaction date | |
| accessChannel | String | 15 | M | Represents the payment channel type that used to collect payments |
| paymentMethod | String | 15 | M | Represents the method of the payment via Bank/PSP Should not be CCARD CASH, EFT, ACTDEB |
| paymentType | String only "Postpaid" | 15 | O | Represents the method of the payment via Bank/PSP Hardcode to "Postpaid" |
| currency | String | 5 | O | Represents the type of the used currency in payment process |
| serviceTypeDetails | ||||
| serviceType | String | 25 | M | Represents the service type of the biller |
| End of serviceTypeDetails | ||||
| payerInfo | Object | M | ||
| idType | string | 3 | C | Represents a unique identifier type (The official number used to identify a customer) |
| id | string | 20 | C | The identification of the customer based on the chosen value from the IdType field |
| nation | char | 2 | C | Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait |
| name | string | 20 | O | |
| phone | string | 20 | O | |
| address | string | 100 | O | |
| string | 100 | O | ||
| joebppsNo | Integer | 10 | C | Represents the unique identifier of the customer profile in eFAWATEERcom |
| End of 'payerInfo' | ||||
| End of 'trxInf' | ||||
| End of 'postpaidAccountTransactions' container |
{
"postpaidAccountTransactions": {
"trxInf": [
{
"acctInfo": {
"billingNo": "1325646",
"billNo": "1325646",
"billerCode": 3
},
"inqRefNo": 883483,
"bankTrxID": "RAJ32165489",
"pmtStatus": "PmtNew",
"dueAmt": 10,
"paidAmt": 10,
"processDate": "2013-12-25T12:53:00",
"accessChannel": "DirectPay",
"paymentMethod": "ACTDEB",
"serviceTypeDetails": {
"serviceType": "FixedLine"
},
"payerInfo": {
"name": "Name",
"joebppsNo": 45645
}
}
]
}
}Mulesoft Response:
Success Response: (200)
Response Body: application/json
| Field Name | Type | Length | Occurrence | Description | Validations |
|---|---|---|---|---|---|
| status | Object | M | |||
| success | Boolean | M | true false | ||
| code | String | 10 | M | Error Code | “0” incase of success or Error Code |
| reasonCode | String | 50 | O | Error Type or Error category | Add this tag only incase of error |
| arabicMessage | String | 200 | M | English message translated to Arabic | تمت العملية بنجاح in case of success or arabic translated error in case of known errors |
| englishMessage | String | 200 | M | Description about the processing | “The Operation has been Successfully Completed” Or error Description |
| End of status | |||||
| response | Object | O | Exists if success = true | ||
| postpaidAccountTransactions | Object | O | |||
| trxInf | Array | M | Repeatable | ||
| acctInfo | Object | M | |||
| billingNo | String | 50 | M | Represents the unique identifier of subscription in a specific service provided by the biller. | |
| billNo | String | 50 | M | bill no. | |
| billerCode | Integer | 3 | M | Represents the unique code of the Biller | |
| End of acctInfo | |||||
| bankTrxID | String | 50 | M | Unique transaction number which is generated for banks collecting payments | |
| pmtStatus | String | 15 | M | Represents the status of the collected payment | |
| dueAmt | Decimal | 12,3 | M | the due amount of the uploaded bill | |
| paidAmt | Decimal | 12,3 | M | Represents the collected payment amount | |
| processDate | DateTime | M | Represents the payment transaction date | ||
| stmtDate | Date | 15 | C | The generated date by eFAWATEERcom which represent when the payment will be settled | |
| joebppsTrx | Integer | 15 | C | Represents the eFAWATEERcom transaction number that used as a unique reference number between all Participants and eFAWATEERcom for each single succeeded payment | |
| result | Object | O | |||
| errorCode | string | 3 | M | ||
| errorDesc | string | 100 | M | ||
| severity | Enum, string | 7 | M | Enum: Error, Info" | |
| End result | |||||
| End trxInf | |||||
| End of 'postpaidAccountTransactions' container | |||||
| End of ‘ response ‘ |
{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"postpaidAccountTransactions": {
"trxInf": [
{
"acctInfo": {
"billingNo": "1325646",
"billNo": "1325646",
"billerCode": 3
},
"bankTrxID": "RAJ32165489",
"pmtStatus": "PmtNew",
"dueAmt": 10,
"paidAmt": 10,
"processDate": "2013-12-25T12:53:00",
"stmtDate": " 2013-12-25",
"joebppsTrx": 150945657,
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
}
}
]
}
}
}Sample Error Response:
Error codes :
400:
content-type: JSON
{
"success": false,
"code": "400",
"reasonCode": "Bad Request",
"arabicMessage": "اقتراح غير جي",
"englishMessage": "paymentMethod is invalid"
}